Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update titles in 'Deployment models' section #1512

Closed
wants to merge 1 commit into from

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Dec 2, 2024

Edu had some feedback on improving the titles in the "Deployment models" section to make more clear that this is about Fleet, and also to improve consistency.

Closes: #1511


Original:
Screenshot 2024-12-02 at 10 13 47 AM

Updated:
Screenshot 2024-12-02 at 10 12 01 AM

Copy link

github-actions bot commented Dec 2, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kilfoyle
Copy link
Contributor Author

@eedugon I spoke with @nimarezainia about this and we're thinking that the change I have above might not be good:

  • "Fleet deployment models" - The deployment isn't specifically about Fleet, since Fleet is only the management UI. So perhaps that title should remain as is, i.e, "Deployment models".
  • "Deploy Fleet Server on Elastic Cloud" and "Deploy Fleet Server on premises and self-managed" - Similarly, these pages aren't only about Fleet Server.

I think you're right that the titles are inconsistent. So instead maybe we should change "Deploy Fleet Server on premises and Elasticsearch on Cloud" to just "Deploy on premises and Elasticsearch on Cloud", like this:
Screenshot 2024-12-12 at 11 21 04 AM

What do you think?

@eedugon
Copy link
Contributor

eedugon commented Dec 12, 2024

"Fleet deployment models" - The deployment isn't specifically about Fleet, since Fleet is only the management UI. So perhaps that title should remain as is, i.e, "Deployment models".

I totally agree on that.
Actually everything is about Fleet (not UI), as the entire book is the fleet book. So Deployment models or Fleet deployment models are totally ok to me.

"Deploy Fleet Server on Elastic Cloud" and "Deploy Fleet Server on premises and self-managed" - Similarly, these pages aren't only about Fleet Server.

mmm I clearly disagree here :)

IMHO, those 2 docs are 95% / 98% about Fleet Server only, and Fleet Server installation is the clear and main goal of the docs. On those two docs, everything, all the paragraphs and sections, are about the Fleet Server. Except very minor sentences or lines.

Of course to install the fleet server we have to setup fleet (a policy, an integration, etc), but that's like part of the process that has the goal of installing / deploying the fleet server itself. Also those docs don't cover the installation of the future Elastic Agents, so more reasons to consider them focused mainly on the Fleet Server component of the Fleet ecosystem.

Anyway, I don't think these names are super important, and I'm happy with whatever you and @nimarezainia prefer, but it's just that the current names have created confusion, and I'll share an example:

Colleagues from support asked me a few weeks ago where we had the Fleet Server installation docs (for on-premises), as they were clearly identified in 7.17 docs and they couldn't find them in the current docs.
After searching and navigating through the docs I actually thought we didn't have those docs anymore :D... until I realized that we actually had 2 docs for Fleet Server installation:

  • Deploy on premises
  • Deploy on premises with Elasticsearch on cloud

None of the names helped anyone to realize that they were about Deploying / Installing the Fleet Server, it's not intuitive at all when the docs are 95% about that.

But as I said I'm ok with cancelling the change.

the question now is... I'm creating the doc Deploying Fleet Server on Kubernetes.... should we call it Deploy Fleet on Kubernetes? It will be the same, we can call it Deploy on Kubernetes, but it's a super ambiguous name where it's almost everything about deploying a Fleet Server on Kubernetes.

@kilfoyle
Copy link
Contributor Author

@nimarezainia just FYI in case you have thoughts on the "deployment models" naming and Edu's comment above.

@nimarezainia
Copy link
Contributor

the question now is... I'm creating the doc Deploying Fleet Server on Kubernetes.... should we call it Deploy Fleet on Kubernetes? It will be the same, we can call it Deploy on Kubernetes, but it's a super ambiguous name where it's almost everything about deploying a Fleet Server on Kubernetes.

@eedugon I think in this instance Deploying Fleet Server on Kubernetes is fine. if you feel that the 'Fleet Server installation" should be bubbled up higher an have it's own section that is ok too. Deploying Fleet Server on Kubernetes could be part of that.

Just thinking about the user's journey, they don't really know about fleet server. They know what the deployment model is that they want. That's why I prefer the "Deploy on-premise" type of section. Obviously we can't help but mention fleet-server in the title for some as that is the distinguishing factor.

@eedugon
Copy link
Contributor

eedugon commented Dec 30, 2024

@nimarezainia , @kilfoyle : I agree with @nimarezainia 's view, and I think it's ok if we don't change anything.

The original inconsistency is maybe not an inconsistency:

image

The third one specifies Fleet Server because one of the stack components will be on premises while Elasticsearch will be on the cloud, so it might have sense to explicitly mention it. As also @nimarezainia mentioned it's the distinguishing factor.

And about the lack of fleet server in the other titles I think it's all a matter of taste, nothing serious.

So, whatever you prefer, we can:

  • Cancel this PR
  • Apply the change proposed by @kilfoyle by removing the fleet server statement.

As soon as we agree I will update (or cancel) this PR. Thanks!

@nimarezainia
Copy link
Contributor

thanks @eedugon - I'm ok cancelling this and concentrating efforts elsewhere. This section's intention was to discuss different deployment models. Fleet server is a component that generally changes where it's deployed in each model - so mentioning that in the titles is fine.

@kilfoyle
Copy link
Contributor Author

kilfoyle commented Jan 2, 2025

Thanks a lot for the input Edu and Nima! Given the explanations it makes sense to me to leave things as is, so I'll cancel this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve titles in "Deployment models" section
4 participants